ULIMS-50: Shipping service incoming shipment redirect #731

MattPrit · 2024-02-20T10:02:40Z

JIRA ticket: ULIMS-50

Depends on #698

Summary:

Adds the option to redirect to the shipping service to book shipments when booking an incoming shipment.

Changes:

Adds feature flag $use_shipping_service_redirect_incoming_shipments which enables/disables this feature
Reduce the number of fields in the create AWB form in the case of a domestic shipment when terms have been accepted
On requesting a booking for an incoming shipment, create a shipment request in the shipping service and redirect to the appropriate shipment workflow to book a shipment
If a shipment request has been created for the incoming shipment, display a 'manage shipment booking' button that links to the shipment request in the shipping service rather than to the 'Print Air Waybill' button.

To test:

To display the new shipment view, go to an active shipment, accept the terms and conditions stipulated for shipping with Diamond's courier
Check that the appropriate 'create awb' form is displayed for academic, domestic, industrial, international shipments
Check that the appropriate shipment request is created in the shipping service when a user submits the form
Check that the 'manage shipment booking' button links to the shipping service correctly once a shipment request has been successfully created

Note:

Requires the addition of the externalShippingIdToSynchrotron column to the Shipping table in ispyb. Since the _get_shipments endpoint now attempts to return this column, a 500 will result whenever this endpoint is called without the new column having been added
The changes contained in this PR (and LIMS-1113: Shipping service dispatch redirect #698) only result in shipping service redirects for domestic academic shipments that have accepted the shipping terms. All other kinds of shipment booking actions are still performed in SynchWeb. Since knowledge of a user's country is known ahead of the redirect, there is still a dependency on lab contacts containing addresses.

…ples

…patch-redirect

gfrn · 2024-02-22T10:50:03Z

Just so we have it in writing, what is the purpose of externalShippingIdToSynchrotron and why should it exist in both Dewar and Shipping?

MattPrit · 2024-03-21T15:03:25Z

Just so we have it in writing, what is the purpose of externalShippingIdToSynchrotron and why should it exist in both Dewar and Shipping?

externalShippingIdToSynchrotron exists only in the Shipping table, it holds the id of the entity in the external shipping service that corresponds to the booking of Shipping's Dewars to the synchrotron. externalShippingIdFromSynchrotron exists only in the Dewar table, it holds the id of the entity in the external shipping service that corresponds to the booking of each Dewar from the synchrotron. These columns are split across multiple tables because, while all Dewars in a shipment are shipped to the synchrotron together, they are dispatched individually. Alternatively, the externalShippingIdToSynchrotron column could be in the Dewar table, but the same id would be duplicated for each Dewar in the 'shipping'.

The required database change has now been made, see DiamondLightSource/ispyb-database#228

client/src/js/modules/shipment/views/createawb.js

api/src/Page/Shipment.php

client/src/js/modules/shipment/views/createawb.js

api/src/Page/Shipment.php

Co-authored-by: Guilherme Francisco <[email protected]>

api/src/Page/Shipment.php

Co-authored-by: Guilherme Francisco <[email protected]>

MattPrit · 2024-04-25T12:28:39Z

New things to test:

Check that, when there is a shipping service 'shipment request' creation error when submitting createawb or dispatch forms, an error message is shown and a redirect is not perfomed
Check that dispatching a Dewar with no defined outgoing lab contact is possible for domestic shipments when shipping terms have been accepted (i.e. hidden fields are no longer required)

gfrn · 2024-04-29T08:42:25Z

There is a possible non-issue, where if you manually delete the package description/shipping date, they cause validation to fail as they are still required, unlike all the other fields.

Not sure if this is an issue, since this would require users to deliberately "break" their own shipment, and I don't see a way this could happen during the "automated" process

* Restore EM menu in dropdown (#766) * Pre release/2024 r2.2 (#770) * LIMS-1201: Amend name of XPDF capillary crystal to use user acronym (#738) Co-authored-by: Mark Williams <[email protected]> * LIMS-1256: Remove validation from Local Contact field (#756) Co-authored-by: Mark Williams <[email protected]> * LIMS-667: Make the Requested Imager a required field if a plate is being created (#733) Co-authored-by: Mark Williams <[email protected]> * LIMS-1261: Fix the grid scan heat maps on the VMXi container view (#744) Co-authored-by: Mark Williams <[email protected]> * LIMS-1289: Fix sample and pdb count on protens page (#753) Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> * Pre release/2024 r2.3 (#772) * LIMS-1207: Move Calendar link to top left * LIMS-1207: Move Migrate link to Lab Contacts page * LIMS-1207: Re-order menu, remove Assign Containers * LIMS-1201: Amend name of XPDF capillary crystal to use user acronym (#738) Co-authored-by: Mark Williams <[email protected]> * LIMS-1256: Remove validation from Local Contact field (#756) Co-authored-by: Mark Williams <[email protected]> * LIMS-667: Make the Requested Imager a required field if a plate is being created (#733) Co-authored-by: Mark Williams <[email protected]> * LIMS-1261: Fix the grid scan heat maps on the VMXi container view (#744) Co-authored-by: Mark Williams <[email protected]> * LIMS-1289: Fix sample and pdb count on protens page (#753) Co-authored-by: Mark Williams <[email protected]> * LIMS-1304: Correct the order of before and after snapshots * LIMS-1304: Update to fix typo Co-authored-by: Mark W <[email protected]> * LIMS-1235: Queries for implicit samples and DCs in project time out (#758) Co-authored-by: Mark Williams <[email protected]> * LIMS-1200: CSV file upload ignores first sample (#737) * LIMS-1200: CSV file upload ignores first sample * LIMS-1200: Fix bug uploading csv with one sample --------- Co-authored-by: Mark Williams <[email protected]> * LIMS-1174: Handle blank proposal on visits page (#740) Co-authored-by: Mark Williams <[email protected]> * LIMS-44: Speed up visit query (#759) Co-authored-by: Mark Williams <[email protected]> * LIMS-1059: Add visit column to shipments list (#742) Co-authored-by: Mark Williams <[email protected]> * Restore EM menu in dropdown (#766) (#768) * Add 2.2a changes to 2.3 (#771) * Restore EM menu in dropdown (#766) * Pre release/2024 r2.2 (#770) * LIMS-1201: Amend name of XPDF capillary crystal to use user acronym (#738) Co-authored-by: Mark Williams <[email protected]> * LIMS-1256: Remove validation from Local Contact field (#756) Co-authored-by: Mark Williams <[email protected]> * LIMS-667: Make the Requested Imager a required field if a plate is being created (#733) Co-authored-by: Mark Williams <[email protected]> * LIMS-1261: Fix the grid scan heat maps on the VMXi container view (#744) Co-authored-by: Mark Williams <[email protected]> * LIMS-1289: Fix sample and pdb count on protens page (#753) Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Dominic Oram <[email protected]> Co-authored-by: Guilherme Francisco <[email protected]> --------- Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Dominic Oram <[email protected]>

…ming-redirect

* LIMS-1204: Remove log area from top of active visits (#735) * LIMS-1204: Remove log area from the top of active visits * LIMS-1204: Remove dclog.js --------- Co-authored-by: Mark Williams <[email protected]> * ULIMS-50: Shipping service incoming shipment redirect (#731) * LIMS-1113: Redirect to shipping-service on dispatch * LIMS-1113: Fix typos in shipping service URLs * LIMS-1113: Change text on submit button if redirecting * LIMS-1113: Fix shipment request requests for Dewars with no pucks/samples * LIMS-1113: Don't redirect for international shipments * LIMS-1113: Tweak logic for international shipments * LIMS-1113: Propagate shipping service error codes to client * LIMS-1113: Link to shipping service from shipping page * LIMS-1113: Restore commented code * LIMS-1113: Include Dewar data in dispatch error log * LIMS-1113: Apply GdF suggestions * LIMS-1113: Update config_sample.php * LIMS-1113: Limit redirects to supported countries * LIMS-1113: Add supported country dropdown to dispatch from * ULIMS-50: Redirect to shipping service to book incoming shipments * Update client/src/js/modules/shipment/views/createawb.js Co-authored-by: Guilherme Francisco <[email protected]> * Update client/src/js/modules/shipment/views/createawb.js Co-authored-by: Guilherme Francisco <[email protected]> * Update api/src/Page/Shipment.php Co-authored-by: Guilherme Francisco <[email protected]> * Update api/src/Page/Shipment.php Co-authored-by: Guilherme Francisco <[email protected]> * ULIMS-50: Add better error messages, make hidden fields not required * ULIMS-50: Update description and date validation in dispatch model * Restore EM menu in dropdown (#766) (#767) * Merge master into prerelease (#773) * Restore EM menu in dropdown (#766) * Pre release/2024 r2.2 (#770) * LIMS-1201: Amend name of XPDF capillary crystal to use user acronym (#738) Co-authored-by: Mark Williams <[email protected]> * LIMS-1256: Remove validation from Local Contact field (#756) Co-authored-by: Mark Williams <[email protected]> * LIMS-667: Make the Requested Imager a required field if a plate is being created (#733) Co-authored-by: Mark Williams <[email protected]> * LIMS-1261: Fix the grid scan heat maps on the VMXi container view (#744) Co-authored-by: Mark Williams <[email protected]> * LIMS-1289: Fix sample and pdb count on protens page (#753) Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> * Pre release/2024 r2.3 (#772) * LIMS-1207: Move Calendar link to top left * LIMS-1207: Move Migrate link to Lab Contacts page * LIMS-1207: Re-order menu, remove Assign Containers * LIMS-1201: Amend name of XPDF capillary crystal to use user acronym (#738) Co-authored-by: Mark Williams <[email protected]> * LIMS-1256: Remove validation from Local Contact field (#756) Co-authored-by: Mark Williams <[email protected]> * LIMS-667: Make the Requested Imager a required field if a plate is being created (#733) Co-authored-by: Mark Williams <[email protected]> * LIMS-1261: Fix the grid scan heat maps on the VMXi container view (#744) Co-authored-by: Mark Williams <[email protected]> * LIMS-1289: Fix sample and pdb count on protens page (#753) Co-authored-by: Mark Williams <[email protected]> * LIMS-1304: Correct the order of before and after snapshots * LIMS-1304: Update to fix typo Co-authored-by: Mark W <[email protected]> * LIMS-1235: Queries for implicit samples and DCs in project time out (#758) Co-authored-by: Mark Williams <[email protected]> * LIMS-1200: CSV file upload ignores first sample (#737) * LIMS-1200: CSV file upload ignores first sample * LIMS-1200: Fix bug uploading csv with one sample --------- Co-authored-by: Mark Williams <[email protected]> * LIMS-1174: Handle blank proposal on visits page (#740) Co-authored-by: Mark Williams <[email protected]> * LIMS-44: Speed up visit query (#759) Co-authored-by: Mark Williams <[email protected]> * LIMS-1059: Add visit column to shipments list (#742) Co-authored-by: Mark Williams <[email protected]> * Restore EM menu in dropdown (#766) (#768) * Add 2.2a changes to 2.3 (#771) * Restore EM menu in dropdown (#766) * Pre release/2024 r2.2 (#770) * LIMS-1201: Amend name of XPDF capillary crystal to use user acronym (#738) Co-authored-by: Mark Williams <[email protected]> * LIMS-1256: Remove validation from Local Contact field (#756) Co-authored-by: Mark Williams <[email protected]> * LIMS-667: Make the Requested Imager a required field if a plate is being created (#733) Co-authored-by: Mark Williams <[email protected]> * LIMS-1261: Fix the grid scan heat maps on the VMXi container view (#744) Co-authored-by: Mark Williams <[email protected]> * LIMS-1289: Fix sample and pdb count on protens page (#753) Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Dominic Oram <[email protected]> Co-authored-by: Guilherme Francisco <[email protected]> --------- Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Dominic Oram <[email protected]> --------- Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Mark W <[email protected]> Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Dominic Oram <[email protected]> * LIMS-1331: Send all dispatch requests to Goods Handling unless international via DHL for BI/MX (#779) Co-authored-by: Mark W <[email protected]> * LIMS-1206: Remove stacked usage bar chart from visit page (#743) * LIMS-1206: Remove stacked usage bar chart from visit page * Remove no longer used modules/stats/views/stack.js --------- Co-authored-by: Mark Williams <[email protected]> * LIMS-1203: Remove hidden temporary button to 'Use facility account' (#741) Co-authored-by: Mark Williams <[email protected]> * LIMS-1342: Show regular create AWB form if shipping redirect not enabled (#780) * LIMS-1342: Show regular create AWB form if shipping redirect not enabled * LIMS-1342: hide extra country dropdown if shipping service redirect not enabled * LIMS-1342: Json encode any error responses * LIMS-1342: define shipping service url even any redirect in use * LIMS-1342: Dont assume https * LIMS-1342: Only show 1 country select dropdown * LIMS-1342: Simplify logic a little * LIMS-1342: Same fixes for dewar dispatch * LIMS-1342: Show correct button if country changes --------- Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Matthew Pritchard <[email protected]> Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Dominic Oram <[email protected]> Co-authored-by: James Hall <[email protected]>

* LIMS-1204: Remove log area from top of active visits (#735) * LIMS-1204: Remove log area from the top of active visits * LIMS-1204: Remove dclog.js --------- Co-authored-by: Mark Williams <[email protected]> * ULIMS-50: Shipping service incoming shipment redirect (#731) * LIMS-1113: Redirect to shipping-service on dispatch * LIMS-1113: Fix typos in shipping service URLs * LIMS-1113: Change text on submit button if redirecting * LIMS-1113: Fix shipment request requests for Dewars with no pucks/samples * LIMS-1113: Don't redirect for international shipments * LIMS-1113: Tweak logic for international shipments * LIMS-1113: Propagate shipping service error codes to client * LIMS-1113: Link to shipping service from shipping page * LIMS-1113: Restore commented code * LIMS-1113: Include Dewar data in dispatch error log * LIMS-1113: Apply GdF suggestions * LIMS-1113: Update config_sample.php * LIMS-1113: Limit redirects to supported countries * LIMS-1113: Add supported country dropdown to dispatch from * ULIMS-50: Redirect to shipping service to book incoming shipments * Update client/src/js/modules/shipment/views/createawb.js Co-authored-by: Guilherme Francisco <[email protected]> * Update client/src/js/modules/shipment/views/createawb.js Co-authored-by: Guilherme Francisco <[email protected]> * Update api/src/Page/Shipment.php Co-authored-by: Guilherme Francisco <[email protected]> * Update api/src/Page/Shipment.php Co-authored-by: Guilherme Francisco <[email protected]> * ULIMS-50: Add better error messages, make hidden fields not required * ULIMS-50: Update description and date validation in dispatch model * Restore EM menu in dropdown (#766) (#767) * Merge master into prerelease (#773) * Restore EM menu in dropdown (#766) * Pre release/2024 r2.2 (#770) * LIMS-1201: Amend name of XPDF capillary crystal to use user acronym (#738) Co-authored-by: Mark Williams <[email protected]> * LIMS-1256: Remove validation from Local Contact field (#756) Co-authored-by: Mark Williams <[email protected]> * LIMS-667: Make the Requested Imager a required field if a plate is being created (#733) Co-authored-by: Mark Williams <[email protected]> * LIMS-1261: Fix the grid scan heat maps on the VMXi container view (#744) Co-authored-by: Mark Williams <[email protected]> * LIMS-1289: Fix sample and pdb count on protens page (#753) Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> * Pre release/2024 r2.3 (#772) * LIMS-1207: Move Calendar link to top left * LIMS-1207: Move Migrate link to Lab Contacts page * LIMS-1207: Re-order menu, remove Assign Containers * LIMS-1201: Amend name of XPDF capillary crystal to use user acronym (#738) Co-authored-by: Mark Williams <[email protected]> * LIMS-1256: Remove validation from Local Contact field (#756) Co-authored-by: Mark Williams <[email protected]> * LIMS-667: Make the Requested Imager a required field if a plate is being created (#733) Co-authored-by: Mark Williams <[email protected]> * LIMS-1261: Fix the grid scan heat maps on the VMXi container view (#744) Co-authored-by: Mark Williams <[email protected]> * LIMS-1289: Fix sample and pdb count on protens page (#753) Co-authored-by: Mark Williams <[email protected]> * LIMS-1304: Correct the order of before and after snapshots * LIMS-1304: Update to fix typo Co-authored-by: Mark W <[email protected]> * LIMS-1235: Queries for implicit samples and DCs in project time out (#758) Co-authored-by: Mark Williams <[email protected]> * LIMS-1200: CSV file upload ignores first sample (#737) * LIMS-1200: CSV file upload ignores first sample * LIMS-1200: Fix bug uploading csv with one sample --------- Co-authored-by: Mark Williams <[email protected]> * LIMS-1174: Handle blank proposal on visits page (#740) Co-authored-by: Mark Williams <[email protected]> * LIMS-44: Speed up visit query (#759) Co-authored-by: Mark Williams <[email protected]> * LIMS-1059: Add visit column to shipments list (#742) Co-authored-by: Mark Williams <[email protected]> * Restore EM menu in dropdown (#766) (#768) * Add 2.2a changes to 2.3 (#771) * Restore EM menu in dropdown (#766) * Pre release/2024 r2.2 (#770) * LIMS-1201: Amend name of XPDF capillary crystal to use user acronym (#738) Co-authored-by: Mark Williams <[email protected]> * LIMS-1256: Remove validation from Local Contact field (#756) Co-authored-by: Mark Williams <[email protected]> * LIMS-667: Make the Requested Imager a required field if a plate is being created (#733) Co-authored-by: Mark Williams <[email protected]> * LIMS-1261: Fix the grid scan heat maps on the VMXi container view (#744) Co-authored-by: Mark Williams <[email protected]> * LIMS-1289: Fix sample and pdb count on protens page (#753) Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Mark Williams <[email protected]> --------- Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Dominic Oram <[email protected]> Co-authored-by: Guilherme Francisco <[email protected]> --------- Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Dominic Oram <[email protected]> --------- Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Mark W <[email protected]> Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Dominic Oram <[email protected]> * LIMS-1331: Send all dispatch requests to Goods Handling unless international via DHL for BI/MX (#779) Co-authored-by: Mark W <[email protected]> * LIMS-1206: Remove stacked usage bar chart from visit page (#743) * LIMS-1206: Remove stacked usage bar chart from visit page * Remove no longer used modules/stats/views/stack.js --------- Co-authored-by: Mark Williams <[email protected]> * LIMS-1203: Remove hidden temporary button to 'Use facility account' (#741) Co-authored-by: Mark Williams <[email protected]> * LIMS-1342: Show regular create AWB form if shipping redirect not enabled (#780) * LIMS-1342: Show regular create AWB form if shipping redirect not enabled * LIMS-1342: hide extra country dropdown if shipping service redirect not enabled * LIMS-1342: Json encode any error responses * LIMS-1342: define shipping service url even any redirect in use * LIMS-1342: Dont assume https * LIMS-1342: Only show 1 country select dropdown * LIMS-1342: Simplify logic a little * LIMS-1342: Same fixes for dewar dispatch * LIMS-1342: Show correct button if country changes --------- Co-authored-by: Mark Williams <[email protected]> * LIMS-1353: Cannot book multiple dewars in one shipment * LIMS-1353: Remove outdated comment --------- Co-authored-by: Mark Williams <[email protected]> Co-authored-by: Matthew Pritchard <[email protected]> Co-authored-by: Guilherme Francisco <[email protected]> Co-authored-by: Dominic Oram <[email protected]> Co-authored-by: James Hall <[email protected]>

MattPrit added 16 commits November 16, 2023 13:10

LIMS-1113: Redirect to shipping-service on dispatch

c55652d

LIMS-1113: Fix typos in shipping service URLs

d73eaad

LIMS-1113: Change text on submit button if redirecting

1a0061f

LIMS-1113: Fix shipment request requests for Dewars with no pucks/sam…

13b2cb8

…ples

LIMS-1113: Don't redirect for international shipments

2ba736c

LIMS-1113: Tweak logic for international shipments

f1ed639

LIMS-1113: Propagate shipping service error codes to client

3b7d8c0

LIMS-1113: Link to shipping service from shipping page

2fbc0ce

LIMS-1113: Restore commented code

d1e756b

LIMS-1113: Include Dewar data in dispatch error log

b7e0713

Merge branch 'prerelease' into feature/lims-1113/shipping-service-dis…

e11330c

…patch-redirect

LIMS-1113: Apply GdF suggestions

f02855d

LIMS-1113: Update config_sample.php

88e293f

LIMS-1113: Limit redirects to supported countries

e1fd023

LIMS-1113: Add supported country dropdown to dispatch from

40f737b

ULIMS-50: Redirect to shipping service to book incoming shipments

1c7cdfa

MattPrit requested review from gfrn and ndg63276 February 20, 2024 10:02

MattPrit marked this pull request as ready for review March 27, 2024 09:25